/*
 * Copyright 2011 ArcBees Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.arcbees.server.auth;

/**
 * Authentication class based on cookies that handle common authentication
 * verification and process.
 *
 * @author Christian Goudreau
 */
public interface Authenticator {
  /**
   * Verify in the database if a cookie exist and if it exist, if that cookie
   * has information that prove that the user is logged in.
   *
   * @param cookie The cookie to search
   * @return The userId
   */
  String isAuthenticated(String cookie);

  /**
   * Create a cookie and authenticate a user with his userId.
   *
   * @param userId The userId.
   */
  void authenticate(String userId);

  /**
   * This make sure that a user is deauthenticated from the server.
   *
   * @param cookie The cookie to delete.
   */
  void deAuthenticate(String cookie);
}
